Feature/cda 99 catalog ts extents versioned by rma-bryson · Pull Request #1808 · USACE/cwms-data-api

rma-bryson · 2026-06-27T01:15:05Z

Summary

Implements timeseries/versions endpoint

Related Issue

Closes #779

Validation

Unit and Integration testing

Checklist

AI tools used

adamkorynta · 2026-07-01T15:25:52Z

+            TimeSeriesDao dao = getTimeSeriesDao(dsl);
+
+            String tsId = requiredParam(ctx, NAME);
+            String office = ctx.queryParam(OFFICE);


office id should be required

Updated to required

adamkorynta · 2026-07-01T15:26:31Z

+            String cursor = ctx.queryParam(PAGE);
+            int pageSize = ctx.queryParamAsClass(PAGE_SIZE, Integer.class).getOrDefault(DEFAULT_PAGE_SIZE);
+
+            ZonedDateTime begin = beginStr != null ? Controllers.queryParamAsZdt(ctx, BEGIN, timezone) : null;


Use Instant to send to the Dao, the Dao's don't need to care about time zones

Updated to Instant.

adamkorynta · 2026-07-01T15:30:03Z

+    @Override
+    public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String names, String office,
+                                                   ZonedDateTime begin, ZonedDateTime end) {
+        Condition condition = AV_CWMS_TS_ID2.CWMS_TS_ID.eq(names);


AV_CWMS_TS_ID2 - I believe this is the view that supports aliases. That should be advertised in the OpenAPI.

added comment to description

adamkorynta · 2026-07-01T15:32:18Z

+    @Override
+    public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String names, String office,
+                                                   ZonedDateTime begin, ZonedDateTime end) {
+        Condition condition = AV_CWMS_TS_ID2.CWMS_TS_ID.eq(names);


This should ignore case, the corrected case will be returned to the client

adamkorynta · 2026-07-01T15:32:35Z



+    @Override
+    public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String names, String office,


Suggested change

public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String names, String office,

public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String name, String office,

adamkorynta · 2026-07-01T15:35:11Z

+                            + "current location in the response stream.  This is an opaque "
+                            + "value, and can be obtained from the 'next-page' value in the response."),
+                    @OpenApiParam(name = PAGE_SIZE, type = Integer.class, description = "How many entries per page returned. "
+                            + "For JSON/XML paging, this controls page size. "


You call out XML and CSV in these docs, but the only accepted content type is json

good catch. Copied over from the timeseries controller and missed that.

adamkorynta · 2026-07-01T15:35:54Z

+                    @OpenApiParam(name = END,  description = "Specifies the "
+                            + "end of the time window for data to be included in the response. If"
+                            + " this field is not specified, any required time window ends at the"
+                            + " current time. "


I don't see the logic to contain to current time

Removed part of comment containing this to current time. Don't see why a user couldn't want to get everything and not provide a time window

adamkorynta · 2026-07-01T15:36:23Z

+                            + "in the response."),
+                    @OpenApiParam(name = BEGIN,  description = "Specifies the "
+                            + "start of the time window for data to be included in the response. "
+                            + "If this field is not specified, any required time window begins 24"


I don't see the 24 hour substitution

I updated the comment. Don't think this makes sense for versions

adamkorynta · 2026-07-01T15:38:19Z

+            Record lastRecord = results.get(results.size() - 1);
+            Timestamp lastVersionTime = lastRecord.get(AV_TS_EXTENTS_UTC.VERSION_TIME);
+            if (lastVersionTime != null) {
+                builder.withNextPage(CwmsDTOPaginated.encodeCursor(DateUtils.toZdt(lastVersionTime).format(DateTimeFormatter.ISO_INSTANT), pageSize, total));


Why are you transforming the version to ZonedDateTime instead of just staying at Insant?

Updated to just use Instant

adamkorynta · 2026-07-01T15:40:33Z

+        .assertThat()
+            .statusCode(is(HttpServletResponse.SC_OK))
+            .body("versions.size()", is(1))
+            .body("next-page", notNullValue())


recommend also testing the total and to make sure the extents aren't accidentally identical in both pages

Added tests of total and confirmation data isn't identical in both pages

…ted to use Instants. Added readTheDocs for timeseries/versions

rma-bryson force-pushed the feature/CDA-99-Catalog-Ts-extents-versioned-improvements branch 5 times, most recently from 00eca9b to 541b051 Compare June 29, 2026 22:50

rma-bryson changed the title ~~Feature/cda 99 catalog ts extents versioned improvements~~ Feature/cda 99 catalog ts extents versioned Jun 29, 2026

rma-bryson marked this pull request as ready for review June 29, 2026 23:00

rma-bryson force-pushed the feature/CDA-99-Catalog-Ts-extents-versioned-improvements branch from 541b051 to 2d95ffb Compare June 30, 2026 16:45

rma-bryson requested a review from adamkorynta June 30, 2026 16:55

MikeNeilson previously approved these changes Jun 30, 2026

View reviewed changes

rma-bryson dismissed MikeNeilson’s stale review via 6091eb9 June 30, 2026 18:45

rma-bryson requested a review from MikeNeilson June 30, 2026 18:59

adamkorynta requested changes Jul 1, 2026

View reviewed changes

rma-bryson force-pushed the feature/CDA-99-Catalog-Ts-extents-versioned-improvements branch from 6091eb9 to 6895c9a Compare July 1, 2026 19:38

rma-bryson added 3 commits July 2, 2026 13:54

CDA-99 - Implements timeseries/versions catalog endpoint

166e72f

CDA-99 - Reverts package-lock.json

e09f671

CDA-99 - Updated openApi descriptions. Added more test coverage. Upda…

b140f18

…ted to use Instants. Added readTheDocs for timeseries/versions

rma-bryson force-pushed the feature/CDA-99-Catalog-Ts-extents-versioned-improvements branch from 6895c9a to b140f18 Compare July 2, 2026 20:55

CDA-99 - Adds back timezone query param

9c9130c



		@Override
		public TimeSeriesVersions getTimeSeriesVersions(String cursor, int pageSize, String names, String office,

Uh oh!

Conversation

rma-bryson commented Jun 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Related Issue

Validation

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rma-bryson Jul 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rma-bryson commented Jun 27, 2026 •

edited

Loading

rma-bryson Jul 1, 2026 •

edited

Loading